home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmDragIcon.z / XmDragIcon
Encoding:
Text File  |  2003-11-18  |  10.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_D_r_a_g_I_c_o_n - The DragIcon widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <Xm/DragDrop.h>
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.       A DragIcon is    a component of the visual used to represent
  16.       the source data in a drag and    drop transaction.  During a
  17.       drag operation, a real or simulated X    cursor provides    drag-
  18.       over visuals consisting of a static portion that represents
  19.       the object being dragged, and    dynamic    cues that provide
  20.       visual feedback during the drag operation.  The visual is
  21.       attained by blending together    various    _X_m_D_r_a_g_I_c_o_n_s specified
  22.       in the _X_m_D_r_a_g_C_o_n_t_e_x_t associated with the drag    operation.
  23.  
  24.       The static portion of    the drag-over visual is    the graphic
  25.       representation that identifies the drag source.  For
  26.       example, when    a user drags several items within a list, a
  27.       DragIcon depicting a list might be supplied as the visual.
  28.       The _X_m_D_r_a_g_C_o_n_t_e_x_t resources, _X_m_N_s_o_u_r_c_e_C_u_r_s_o_r_I_c_o_n or
  29.       _X_m_N_s_o_u_r_c_e_P_i_x_m_a_p_I_c_o_n, specify a DragIcon to use for the
  30.       static portion of the    visual.
  31.  
  32.       A drag-over visual incorporates dynamic cues in order    to
  33.       provide visual feedback in response to the user's actions.
  34.       For instance,    the drag-over visual might use different
  35.       indicators to    identify the type of operation (copy, link, or
  36.       move)    being performed.  Dynamic cues could also alert    the
  37.       user that a drop site    is valid or invalid as the pointer
  38.       traverses the    drop site.  The    _X_m_N_o_p_e_r_a_t_i_o_n_C_u_r_s_o_r_I_c_o_n and
  39.       _X_m_N_s_t_a_t_e_C_u_r_s_o_r_I_c_o_n resources of _X_m_D_r_a_g_C_o_n_t_e_x_t    specify
  40.       DragIcons for    dynamic    cues.
  41.  
  42.       A drag-over visual typically consists    of a source, operation
  43.       and state DragIcon.  The _X_m_N_b_l_e_n_d_M_o_d_e_l resource of
  44.       _X_m_D_r_a_g_C_o_n_t_e_x_t    offers several options that determine which
  45.       icons    are blended to produce the drag-over visual.  DragIcon
  46.       resources control the    relative position of the operation and
  47.       state    icons (if used).  If a particular DragIcon is not
  48.       specified, the toolkit uses the _X_m_S_c_r_e_e_n default DragIcons.
  49.  
  50.       An application initializes a DragIcon    with the function
  51.       _X_m_C_r_e_a_t_e_D_r_a_g_I_c_o_n or through entries in the resource
  52.       database.  If    a pixmap and its mask (optional) are specified
  53.       in the resource database, the    toolkit    converts the values in
  54.       the X11 Bitmap file format and assigns values    to the
  55.       corresponding    resources.
  56.  
  57.     CCCCllllaaaasssssssseeeessss
  58.       DragIcon inherits behavior and a resource from _O_b_j_e_c_t.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       The class pointer is _x_m_D_r_a_g_I_c_o_n_O_b_j_e_c_t_C_l_a_s_s.
  75.  
  76.       The class name is _X_m_D_r_a_g_I_c_o_n.
  77.  
  78.     NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  79.       The following    table defines a    set of widget resources    used
  80.       by the programmer to specify data.  The programmer can also
  81.       set the resource values for the inherited classes to set
  82.       attributes for this widget.  To reference a resource by name
  83.       or by    class in a .Xdefaults file, remove the _X_m_N or _X_m_C
  84.       prefix and use the remaining letters.     To specify one    of the
  85.       defined values for a resource    in a .Xdefaults    file, remove
  86.       the _X_m prefix    and use    the remaining letters (in either
  87.       lowercase or uppercase, but include any underscores between
  88.       words).  The codes in    the access column indicate if the
  89.       given    resource can be    set at creation    time (_C), set by using
  90.       _X_t_S_e_t_V_a_l_u_e_s (_S), retrieved by    using _X_t_G_e_t_V_a_l_u_e_s (_G), or is
  91.       not applicable (_N/_A).
  92.  
  93.                 XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  94.      NNNNaaaammmmeeee         CCCCllllaaaassssssss         TTTTyyyyppppeeee         DDDDeeeeffffaaaauuuulllltttt            AAAAcccccccceeeessssssss
  95.      _____________________________________________________________________________
  96.      XmNattachment   XmCAttachment   unsigned char   XmATTACH_NORTH_WEST    CSG
  97.      XmNdepth         XmCDepth         int         1                CSG
  98.      XmNheight         XmCHeight         Dimension         0                CSG
  99.      XmNhotX         XmCHot         Position         0                CSG
  100.      XmNhotY         XmCHot         Position         0                CSG
  101.      XmNmask         XmCPixmap         Pixmap         XmUNSPECIFIED_PIXMAP   CSG
  102.      XmNoffsetX         XmCOffset         Position         0                CSG
  103.      XmNoffsetY         XmCOffset         Position         0                CSG
  104.      XmNpixmap         XmCPixmap         Pixmap         XmUNSPECIFIED_PIXMAP   CSG
  105.      XmNwidth         XmCWidth         Dimension         0                CSG
  106.  
  107.  
  108.       _X_m_N_a_t_t_a_c_h_m_e_n_t
  109.            Specifies a relative location on    the source icon    for
  110.            the attachment of the state or operation    icon.  The
  111.            origin of the state and operation icons is aligned with
  112.            the specified compass point on the source icon.    The
  113.            _X_m_N_o_f_f_s_e_t_X and _X_m_N_o_f_f_s_e_t_Y resources can be used to
  114.            further refine the icon positions.  The possible    values
  115.            are
  116.  
  117.       _X_m_A_T_T_A_C_H__N_O_R_T_H__W_E_S_T
  118.            Attaches    the origin of the state    or operation icon to
  119.            the northwest point on the source icon.
  120.  
  121.       _X_m_A_T_T_A_C_H__N_O_R_T_H
  122.            Attaches    the origin of the state    or operation icon to
  123.            the north point on the source icon.
  124.  
  125.       _X_m_A_T_T_A_C_H__N_O_R_T_H__E_A_S_T
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  137.  
  138.  
  139.  
  140.            Attaches    the origin of the state    or operation icon to
  141.            the northeast point on the source icon.
  142.  
  143.       _X_m_A_T_T_A_C_H__E_A_S_T
  144.            Attaches    the origin of the state    or operation icon to
  145.            the east    point on the source icon.
  146.  
  147.       _X_m_A_T_T_A_C_H__S_O_U_T_H__E_A_S_T
  148.            Attaches    the origin of the state    or operation icon to
  149.            the southeast point on the source icon.
  150.  
  151.       _X_m_A_T_T_A_C_H__S_O_U_T_H
  152.            Attaches    the origin of the state    or operation icon to
  153.            the south point on the source icon.
  154.  
  155.       _X_m_A_T_T_A_C_H__S_O_U_T_H__W_E_S_T
  156.            Attaches    the origin of the state    or operation icon to
  157.            the southwest point on the source icon.
  158.  
  159.       _X_m_A_T_T_A_C_H__W_E_S_T
  160.            Attaches    the origin of the state    or operation icon to
  161.            the west    point on the source icon.
  162.  
  163.       _X_m_A_T_T_A_C_H__C_E_N_T_E_R
  164.            Attaches    the origin of the state    or operation icon to
  165.            the center of the source    icon.  The _X_m_N_o_f_f_s_e_t_X and
  166.            _X_m_N_o_f_f_s_e_t_Y resources may    be used    to center the attached
  167.            icon.
  168.  
  169.       _X_m_A_T_T_A_C_H__H_O_T
  170.            Attaches    the hotspot coordinates    of a state or
  171.            operation DragIcon to an    xxxx,,,,yyyy position on    the source
  172.            icon.  The xxxx,,,,yyyy coordinate is taken from the event
  173.            passed to the _X_m_D_r_a_g_S_t_a_r_t function, and made relative
  174.            to the widget passed as an argument to the same
  175.            function.  Specifies the    depth of the pixmap.
  176.            Specifies the height of the pixmap.  Specifies the x-
  177.            coordinate of the hotspot of a cursor DragIcon in
  178.            relation    to the origin of the pixmap bounding box.
  179.            Specifies the y-coordinate of the hotspot of a cursor
  180.            DragIcon    in relation to the origin of the pixmap
  181.            bounding    box.  Specifies    a pixmap of depth one to use
  182.            as the DragIcon mask pixmap.  Specifies a horizontal
  183.            offset (in pixels) of the origin    of the state or
  184.            operation icon relative to the attachment point on the
  185.            source icon.  A positive    offset value moves the origin
  186.            to the right; a negative    value moves the    origin to the
  187.            left.  Specifies    a vertical offset (in pixels) of the
  188.            origin of the state or operation    icon relative to the
  189.            attachment point    on the source icon.  A positive    offset
  190.            value moves the origin down; a negative value moves the
  191.            origin up.  Specifies a pixmap to use as    the DragIcon
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 11/11/03)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  203.  
  204.  
  205.  
  206.            pixmap.    Specifies the width of the pixmap.
  207.  
  208.     IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  209.       DragIcon inherits behavior and a resource from _O_b_j_e_c_t.  For
  210.       a complete description of this resource, refer to the    _O_b_j_e_c_t
  211.       man page.
  212.  
  213.                  OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  214.      NNNNaaaammmmeeee          CCCCllllaaaassssssss        TTTTyyyyppppeeee         DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  215.      ____________________________________________________________________
  216.      XmNdestroyCallback      XmCCallback    XtCallbackList     NULL       C
  217.  
  218.  
  219.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  220.       _O_b_j_e_c_t(_3_X), _X_m_C_r_e_a_t_e_D_r_a_g_I_c_o_n(_3_X), _X_m_D_i_s_p_l_a_y(_3_X),
  221.       _X_m_D_r_a_g_C_o_n_t_e_x_t(_3_X), _X_m_D_r_o_p_S_i_t_e(_3_X), _X_m_D_r_o_p_T_r_a_n_s_f_e_r(_3_X), and
  222.       _X_m_S_c_r_e_e_n(_3_X).
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                        (printed 11/11/03)
  262.  
  263.  
  264.  
  265.